Preparing Your System for CygNet Bridge API
CygNet Bridge API is a separately available CygNet product that provides a web service to request your CygNet data over the internet, allowing you to create your own web applications to securely access your CygNet system data.
Accessing the CygNet Bridge API requires the installation of CygNet Bridge software, and the Bridge API feature must be selected as an option during the CygNet Bridge installation process. CygNet Bridge maintains secure data access, allowing you to access required CygNet data without direct access to a CygNet system. You can optionally require two-factor authentication to be granted access to the CygNet Bridge API. See Providing Two-Factor Authentication for more information.
See CygNet Bridge for general information about that component.
CygNet Bridge API is licensed in conjunction with CygNet Bridge, which must be licensed separately from existing CygNet SCADA or CygNet Measurement software components. Licensing for CygNet Bridge API is provided according to license type; you can obtain Base licensing for API access, or obtain optional Alarm and/or Control licensing to gain access to additional features. For more information about obtaining and licensing the CygNet Bridge API and CygNet Bridge products, contact your Account Manager or CygNet Sales.
Features included in each license type are described in the following table.
| License Type | CygNet Bridge API Features Included |
|---|---|
|
Base |
All CygNet Bridge APIs except those features provided with the "Alarm" or "Control" licenses See API Information Types for a list of provided types. |
|
Alarm |
All base license features plus:
|
|
Control |
All base license features plus:
|
Note: When you install an updated CygNet license file, use the IIS Manager to recycle CygNet Bridge in the IIS Application Pools list. This will refresh your web application and pick up new functionality. Refer to Microsoft IIS (Internet Information Services) online documentation if you need more information about the recycle process.
CygNet Bridge API requires the installation of CygNet Bridge software, and must be selected as an option during the CygNet Bridge installation process.
Accessing the CygNet Bridge API includes the following steps.
See Preparing Your System for CygNet Bridge API and (optionally) Providing Two-Factor Authentication for more information.
See Installing CygNet Bridge for more information.
See Accessing and Updating CygNet Bridge API for more information.
Use CygNet Bridge API in conjunction with CygNet Bridge and CygNet Software v8.5.1 or greater to access your CygNet data via the web. See the CygNet Release Documents for more information about current software version requirements and considerations appropriate for your installation and usage.
A variety of CygNet Bridge APIs are provided to support operations involving the following CygNet information types.
|
|
Note: Some API calls require specific licensing types. See Licensing above.
The CygNet Bridge APIs are accessible to authorized users of a licensed CygNet installation who are also authorized on the web server domain. Access is granted according to configured permission levels and the features you have licensed.
Authorization depends on:
See Security and CygNet Bridge API Security for more information about setting up permissions in CygNet.
See Accessing and Updating CygNet Bridge API for more information.
Note: When the authorization token expires, CygNetBridgeAPI will return the status "401 Unauthorized" and deny authorization. If that occurs, obtain a new authorization token by calling the client login API again.
Request an authorization token via the ClientLoginAPI method in your CygNet Bridge site in IIS. Prior to calling any CygNet Bridge API methods, obtain an authorization token, using the method clientloginapi/api/login and then pass the obtained token into all CygNet Bridge API requests in a header named X-WFT-AuthToken.
Valid CygNet Bridge API requests must contain headers for the authorization token received and the CygNet domain ID, as follows.
Note: Additional requirements apply if you have opted to use two-factor authentication. See Providing Two-Factor Authentication for more information.
CygNet Bridge API errors are logged to your Weatherford\CygNetBridge\Logs folder as CygNetBridgeApi[logfile number].csv files
Assistance using the Bridge API is provided via a sample application. The CygNet Bridge API installation set includes the sample web application (BridgeAPISampleApp\sample folder in your CygNet Bridge source files) that contains examples for using the Bridge API to develop your customized web application, and for using two-factor authentication. See Building the CygNet Bridge API Sample Web Application for more information.
CygNet Bridge API generates web-accessible user documents using an auto-generated interactive documentation library tool. These documents provide up-to-date information and examples to help developers with API usage. Navigate to localhost/CygNet/Help to access the help documents after CygNet Bridge is installed.
Note: If you have installed CygNet Bridge with HTTPS (strongly recommended), navigate to https://[YourWebHost]/CygNet/Help.
See an offline version of the CygNet Bridge API Help here.
Other portions of the CygNet Help file also pertain to preparation or installation of CygNet Bridge API. The following related topics may prove helpful:
To address questions or circumstances beyond the scope of the CygNet Help, Additional CygNet Resources are available.
More:
Preparing Your System for CygNet Bridge API
Providing Two-Factor Authentication
Accessing and Updating CygNet Bridge API
Building the CygNet Bridge API Sample Web Application
Troubleshooting CygNet Bridge API
|
|
|
